home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sggglm.z / sggglm
Encoding:
Text File  |  2002-10-03  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGGGGGGGGGLLLLMMMM((((3333SSSS))))                                                          SSSSGGGGGGGGGGGGLLLLMMMM((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGGGLM - solve a general Gauss-Markov linear model (GLM) problem
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      SUBROUTINE SGGGLM( N, M, P, A, LDA, B, LDB, D, X, Y, WORK, LWORK, INFO )
  13.  
  14.          INTEGER        INFO, LDA, LDB, LWORK, M, N, P
  15.  
  16.          REAL           A( LDA, * ), B( LDB, * ), D( * ), WORK( * ), X( * ),
  17.                         Y( * )
  18.  
  19. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  20.      These routines are part of the SCSL Scientific Library and can be loaded
  21.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  22.      directs the linker to use the multi-processor version of the library.
  23.  
  24.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  25.      4 bytes (32 bits). Another version of SCSL is available in which integers
  26.      are 8 bytes (64 bits).  This version allows the user access to larger
  27.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  28.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  29.      only one of the two versions; 4-byte integer and 8-byte integer library
  30.      calls cannot be mixed.
  31.  
  32. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  33.      SGGGLM solves a general Gauss-Markov linear model (GLM) problem:
  34.              minimize || y ||_2   subject to   d = A*x + B*y
  35.                  x
  36.  
  37.      where A is an N-by-M matrix, B is an N-by-P matrix, and d is a given N-
  38.      vector. It is assumed that M <= N <= M+P, and
  39.  
  40.                 rank(A) = M    and    rank( A B ) = N.
  41.  
  42.      Under these assumptions, the constrained equation is always consistent,
  43.      and there is a unique solution x and a minimal 2-norm solution y, which
  44.      is obtained using a generalized QR factorization of A and B.
  45.  
  46.      In particular, if matrix B is square nonsingular, then the problem GLM is
  47.      equivalent to the following weighted linear least squares problem
  48.  
  49.                   minimize || inv(B)*(d-A*x) ||_2
  50.                       x
  51.  
  52.      where inv(B) denotes the inverse of B.
  53.  
  54.  
  55. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  56.      N       (input) INTEGER
  57.              The number of rows of the matrices A and B.  N >= 0.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGGGGGGGGGLLLLMMMM((((3333SSSS))))                                                          SSSSGGGGGGGGGGGGLLLLMMMM((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      M       (input) INTEGER
  75.              The number of columns of the matrix A.  0 <= M <= N.
  76.  
  77.      P       (input) INTEGER
  78.              The number of columns of the matrix B.  P >= N-M.
  79.  
  80.      A       (input/output) REAL array, dimension (LDA,M)
  81.              On entry, the N-by-M matrix A.  On exit, A is destroyed.
  82.  
  83.      LDA     (input) INTEGER
  84.              The leading dimension of the array A. LDA >= max(1,N).
  85.  
  86.      B       (input/output) REAL array, dimension (LDB,P)
  87.              On entry, the N-by-P matrix B.  On exit, B is destroyed.
  88.  
  89.      LDB     (input) INTEGER
  90.              The leading dimension of the array B. LDB >= max(1,N).
  91.  
  92.      D       (input/output) REAL array, dimension (N)
  93.              On entry, D is the left hand side of the GLM equation.  On exit,
  94.              D is destroyed.
  95.  
  96.      X       (output) REAL array, dimension (M)
  97.              Y       (output) REAL array, dimension (P) On exit, X and Y are
  98.              the solutions of the GLM problem.
  99.  
  100.      WORK    (workspace/output) REAL array, dimension (LWORK)
  101.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  102.  
  103.      LWORK   (input) INTEGER
  104.              The dimension of the array WORK. LWORK >= max(1,N+M+P).  For
  105.              optimum performance, LWORK >= M+min(N,P)+max(N,P)*NB, where NB is
  106.              an upper bound for the optimal blocksizes for SGEQRF, SGERQF,
  107.              SORMQR and SORMRQ.
  108.  
  109.              If LWORK = -1, then a workspace query is assumed; the routine
  110.              only calculates the optimal size of the WORK array, returns this
  111.              value as the first entry of the WORK array, and no error message
  112.              related to LWORK is issued by XERBLA.
  113.  
  114.      INFO    (output) INTEGER
  115.              = 0:  successful exit.
  116.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  117.  
  118. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  119.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  120.  
  121.      This man page is available only online.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.